home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / makedoc_v1.1.lha / makedoc / doc / deutsch / makedoc.dok < prev   
Encoding:
Text File  |  1995-01-09  |  5.8 KB  |  139 lines
  1. makedoc                                                                 makedoc
  2.  
  3. $VER: makedoc.dok 1.1 (08.05.94)
  4.  
  5. NAME
  6.     makedoc
  7.  
  8. FORMAT
  9.     makedoc [FILES] file1 [file2] [...] AUTODOC docfile [TEMPFILE temporyfile]
  10.             [BEGIN string] [END string] [SKIPSTRING string] [TABS numspcs]
  11.             [LINELENGTH numchars] [CONVERTCOMMENTS] [NOWORDWRAP] [NOFORMFEED]
  12.             [TOC] [LANGUAGE sprache] [AMIGAGUIDE] [NOICON] [VERBOSE]
  13.             [APPEND file] [VERSION version-nummer] [REVISION revisions-nummer]
  14.             [REVISIONFILE file]
  15.  
  16. SCHABLONE
  17.     FILES/M/A,AUTODOC/K/A,TEMPFILE/K,BEGIN/K,END/K,SKIPSTRING/K,TABS/N,
  18.     LINELENGTH/N,CONVERTCOMMENTS/S,NOWORDWRAP/S,NOFORMFEED/S,TOC/S,
  19.     LANGUAGE/K,AMIGAGUIDE/S,NOICON/S,VERBOSE/S,APPEND/K,VERSION/N,
  20.     REVISION/N/K,REVISIONFILE/K
  21.  
  22. FUNKTION
  23.     extrahiert Dokumentationsfragmente aus Dateien und fügt sie in sortierter
  24.     Folge zu einer Dokumentationsdatei zusammen. (Format AutoDoc).
  25.     Makedoc unterstützt das Erstellen von verschieden sprachigen Dokumenta-
  26.     tionen, in dem in den BEGIN String das Muster "LL" irdendwo eingesetzt
  27.     wird. An dieser Stelle wird dann die entsprechende Abkürzung für die
  28.     angegebene Sprache gesucht und wenn gefunden wird das Dokumentfragment
  29.     extrahiert. Somit ist es möglich ein zwei oder mehrsprachige Dokumentation
  30.     zu erstellen. Folgende Abkürzungen sind momentan unterstützt , wobei ein
  31.     Fragezeichen für einen beliebigen Buchstaben steht :
  32.  
  33.       "DK" -    dansk
  34.       "D?" -    deutsch
  35.       "E?" -    español
  36.       "F?" -    français
  37.       "GB" -    english
  38.       "I?" -    italiano
  39.       "NL" -    nederlands
  40.       "N?" -    norsk
  41.       "P?" -    português
  42.       "S?" -    svenska
  43.  
  44.     Makedoc generiert auch Piktogramme für die Dokumentation , wenn nicht
  45.     die Option NOICON angegeben wurde. Dabei wird erst versucht das Piktogramm
  46.     Env:Sys/def_doc.info zu benutzen. Wenn dies nicht existiert wird das
  47.     standard Pitkogramm WBPROJECT benutzt !
  48.     Wenn REVISIONFILE oder REVISION angegeben wird,dann wird in dem gefundenen
  49.     Dokumentationsfragment nach dem vorkommen von "$VER: " in einer Zeile
  50.     gesucht und wenn dies gefunden wurde die entsprechenden Werte eingesetzt
  51.     (VERSION,REVISION,DATUM (nur bei REVISIONFILE) und NAME).
  52.  
  53. EINGABE
  54.     FILES - ein oder mehrere Quelldateien
  55.     AUTODOC - zu erstellende AutoDoc-Datei. Wenn keine Sprache angegeben und
  56.         hier im Pfad eine Sprache spezifiziert ist wird diese benutzt.Z.B. für
  57.         doc/deutsch/test.doc wird die Sprache 'deutsch' benutzt
  58.     TEMPFILE - zu benutzende temporäre Datei
  59.     BEGIN - String, der zur Identifikation des Anfangs eines Dokumentations-
  60.         fragmentes dient (Standard : "/******")
  61.     END - String, der zur Identifikation des Endes eines Dokumentations-
  62.         fragmentes dient (Standard : "***")
  63.     SKIPSTRING - String, der am Anfang einer Zeile im Dokumentationsfragment
  64.         übersprungen werden soll (Standard : "*")
  65.     TABS - Anzahl Leerzeichen , die für Tabulatoren ersetzt werden
  66.     LINELENGTH - Maximale Anzahl Zeichen für eine Zeile (Standard : 78)
  67.     CONVERTCOMMENT - konvertiert backslash in ein slash wenn ein Stern folgt
  68.         oder vorangegangen ist
  69.     NOWORDWRAP - schaltet den Zeilenumbruch, bei zu langer Zeile aus
  70.     NOFORMFEED - es wird kein Formfeed nach jedem Dokumentationsfragment
  71.         eingefügt
  72.     TOC - erstellt "Table of Contents"
  73.     LANGUAGE - erstellt nur die Dokumentation für die angegebene Sprachen
  74.         (Ausgeschrieben) .Siehe oben aufgeführten Sprachen.
  75.     AMIGAGUIDE - erstelle Datei im AmigaGuide Format und nicht im AutoDoc
  76.     NOICON - generiert kein Piktogramm für das Dokument
  77.     VERBOSE - zeige parse Informationen an
  78.     APPEND - Datei, die an das Ende der Dokumentation angehängt wird,z.B. ein
  79.         allgemeiner Copyright-Vermerk oder etwas ähnliches
  80.     VERSION - Versionsnummer der Dokumentation/des Programms
  81.     REVISION - Revisionsnummer der Dokumentation/des Programms
  82.     REVISIONFILE - Datei, in der die Revisionsnummer der Dokumentation/
  83.         des Programms steht (siehe bumprev). REVISIONFILE hat eine höher
  84.         Priorität als REVISION und überschreibt damit REVISION. Außerdem
  85.         wird das Datum des REVISIONFILE's benutzt.
  86.  
  87. BEISPIEL
  88.     makedoc test.c AUTODOC test.doc BEGIN "/**LL******" END "******" \
  89.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE deutsch
  90.  
  91.     oder
  92.  
  93.     makedoc test.c AUTODOC doc/deutsch/test.doc BEGIN "/**LL******" \
  94.             END "******" SKIPSTRING "**" TOC VERBOSE
  95.  
  96.     würde alle Fragmente extrahieren, die folgendermaßen Aussehen :
  97.  
  98.     /*D**** test.lib/test ****************************************************
  99.     *
  100.     * hier die Dokumentation für test aus test.c
  101.     *
  102.     ***** ENDE der Dokumentation ********************************************/
  103.  
  104.     Folgende Kommandozeile extrahiert nur Fragmente für z.B. Menüs :
  105.  
  106.     makedoc test.c AUTODOC test.doc BEGIN "/**LL**MENU**" END "******" \
  107.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE deutsch
  108.  
  109.     würde nur folgende Fragmente extrahieren
  110.  
  111.     /*D**MENU* Menü/Projekt/Öffnen *******************************************
  112.     *
  113.     * hier die Menü-Dokumentation aus test.c
  114.     *
  115.     ***** ENDE der Menü-Dokumentation ***************************************/
  116.  
  117. BEMERKUNG
  118.     makedoc benutzt ReadArgs , deshalb muß für ein "*" immer zwei angegeben
  119.     werden also "**" , weil ReadArgs den Stern benutzt, um Sonderzeichen aus-
  120.     geben. Z.B. "*N" ist ein Zeilenvorschub !
  121.  
  122. SYSTEM ANFORDERUNG
  123.     Jeder Amiga mit OS2.04 (V37) oder größer. Empfehlung ist OS3.x , es ist
  124.     einfach eine große Verbesserung (Datatypes etc.).
  125.  
  126. SIEHE AUCH
  127.     autodoc
  128.  
  129. COPYRIGHT
  130.     (C) Copyright 1993,1994 by Stefan Ruppert
  131.     Makedoc ist frei kopierbar, solange alle in Contents-List aufgeführten
  132.     Dateien nicht verändert und mit kopiert werden.
  133.  
  134. ANREGUNGEN,BUGS ?,GESCHENKE,PROGRAMME UND AMIGAS AN:
  135.     Stefan Ruppert
  136.     Windthortstraße 5
  137.     65439 Flörsheim am Main
  138.  
  139.